ip-group

This command configures the IP Groups table, which lets you define IP Groups.

Syntax

(config-voip)# ip-group <Index>
(ip-group-<Index>)# 

Command

Description

Index

Defines the table row index.

always-use-route-table {disable|enable}

Defines the Request-URI host name in outgoing INVITE messages.

always-use-source-addr {disable|enable}

Enables the device to always send SIP requests and responses, within a SIP dialog, to the source IP address received in the previous SIP message packet.

authentication-method-list

Defines SIP methods received from the IP Group that must be challenged by the device when the device acts as an Authentication server.

authentication-mode {sbc-as-client|sbc-as-server|user-authenticates}

Defines the authentication mode.

bandwidth-profile

Assigns a Bandwidth Profile rule.

cac-profile

Assigns a Call Admission Control Profile.

call-setup-rules-set-id

Assigns a Call Setup Rule Set ID.

classify-by-proxy-set {disable|enable}

Enables classification of incoming SIP dialogs (INVITEs) to Server-type IP Groups based on Proxy Set (assigned using the IPGroup_ProxySetName parameter).

contact-user

Defines the user part of the From, To, and Contact headers of SIP REGISTER messages, and the user part of the Contact header of INVITE messages received from this IP Group and forwarded by the device to another IP Group.

dst-uri-input

Defines the SIP header in the incoming INVITE to use as a call matching characteristic based on destination URIs.

dtls-context

Assigns a TLS Context (certificate) to the IP Group, which is used for DTLS sessions (handshakes) with the IP Group.

inbound-mesg-manipulation-set

Assigns a Message Manipulation Set (rule) to the IP Group for SIP message manipulation on the inbound leg.

internal-media-realm-name

Assigns an "internal" Media Realm to the IP Group. This is applicable when the device is deployed in a Microsoft Teams environment. The device selects this Media Realm (instead of the Media Realm assigned by the media-realm-name command) if the value of the X-MS-UserLocation header in the incoming SIP message is "Internal" and the teams-local-media-optimization-handling command is configured to any value other than none.

ip-profile-name

Assigns an IP Profile to the IP Group.

local-host-name

Defines the host name (string) that the device uses in the SIP message's Via and Contact headers.

max-num-of-reg-users

Defines the maximum number of users in this IP Group that can register with the device.

media-realm-name

Assigns a Media Realm to the IP Group.

msg-man-user-defined-string1

Defines a value for the SIP user part that can be used in Message Manipulation rules configured in the Message Manipulations table.

msg-man-user-defined-string2

Defines a value for the SIP user part that can be used in Message Manipulation rules configured in the Message Manipulations table.

name

Defines a descriptive name, which is used when associating the row in other tables.

outbound-mesg-manipulation-set

Assigns a Message Manipulation Set (rule) to the IP Group for SIP message manipulation on the outbound leg.

password

Defines the shared password for authenticating the IP Group, when the device acts as an Authentication server.

proxy-keepalive-use-ipg {disable|enable}

Enables the device to apply certain IP Group settings to keep-alive SIP OPTIONS messages that are sent by the device to the proxy server.

proxy-set-name

Assigns a Proxy Set to the IP Group. All INVITE messages destined to the IP Group are sent to the IP address configured for the Proxy Set.

qoe-profile

Assigns a Quality of Experience Profile rule.

re-routing-mode {not-configured|proxy|routing-table|standard}

Defines the routing mode after a call redirection (i.e., a 3xx SIP response is received) or transfer (i.e., a SIP REFER request is received).

registration-mode {no-registrations|sbs-initiates|user-initiates}

Defines the registration mode for the IP Group.

sbc-alt-route-reasons-set

Assigns an Alternative Reasons Set to the IP Group.

sbc-client-forking-mode {parallel|sequential|sequential-available-only}

Defines call forking of INVITE messages to up to five separate SIP outgoing legs for User-type IP Groups.

sbc-dial-plan-name

Assigns a Dial Plan to the IP Group.

sbc-keep-call-id

Enables the device to use the same call identification (SIP Call-ID header value) received in incoming messages for the call identification in outgoing messages.

sbc-operation-mode {b2bua|call-stateful-proxy|microsoft-server|not-configured}

Defines the device's operational mode for the IP Group.

sbc-psap-mode {disable|enable}

Enables E9-1-1 emergency call routing in a Microsoft Skype for Business environment.

sbc-server-auth-type {according-to-global-parameter|arm|locally|remotely-according-draft-sterman|remotely-by-oauth}

Defines the authentication method when the device, as an Authentication server, authenticates SIP requests from the IP Group.

sbc-user-stickiness {disable|enable}

Enables SBC user registration "stickiness" to a registrar.

sip-connect

Defines the IP Group as a registered server that represents multiple users.

sip-group-name

Defines the SIP Request-URI host name in INVITE and REGISTER messages sent to the IP Group, or the host name in the From header of INVITE messages received from the IP Group.

sip-source-host-name

Defines the hostname of the URI in certain SIP headers, overwriting the original host part of the URI.

src-uri-input

Defines the SIP header in the incoming INVITE that is used for call matching characteristics based on source URIs.

srd-name

Assigns an SRD to the IP Group.

tags

Assigns Dial Plan tags for routing and manipulation.

teams-direct-routing-mode

Enables the device to include Microsoft's proprietary X-MS-SBC header in outgoing SIP INVITE and OPTIONS messages in a Microsoft Teams Direct Routing environment.

teams-local-media-optimization-handling {none| sbc-decides| teams-decides}

Enables and defines media optimization handling when the device is deployed in a Microsoft Teams environment. The handling is based on Microsoft proprietary SIP headers, X-MS-UserLocation and X-MS-MediaPath.

teams-local-mo-initial-behavior {direct-media| external| internal}

Defines how the central SBC device (proxy SBC scenario) initially sends the received INVITE message with the SDP Offer to Teams when the device is deployed in a Microsoft Teams environment for Media Optimization.

topology-location {down|up}

Defines the display location of the IP Group in the Topology view of the Web interface.

type {gateway|server|user}

Defines the type of IP Group

use-requri-port {disable|enable}

Enables the device to use the port indicated in the Request-URI of the incoming message as the destination port when routing the message to the IP Group.

used-by-routing-server {not-used|used}

Enables the IP Group to be used by a third-party routing server for call routing decisions.

username

Defines the shared username for authenticating the IP Group, when the device acts as an Authentication server.

uui-format {disable|enable}

Enables the generation of the Avaya UCID value, adding it to the outgoing INVITE sent to this IP Group.

Command Mode

Privileged User

Example

This example configures a Server-type IP Group called "ITSP":

(config-voip)# ip-group 0
(ip-group-0)# name ITSP
(ip-group-0)# type server
(ip-group-0)# media-realm-name ITSP
(ip-group-0)# activate